home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Diamond Collection / The Diamond Collection (Software Vault)(Digital Impact).ISO / cdr37 / jmod1002.zip / JMOD.TXT < prev    next >
Text File  |  1995-02-12  |  3KB  |  73 lines
  1. ═══════════════════════════════════════════════════════════════════════════════
  2. ABOUT JMOD AND THE JMOD FORMAT
  3.  
  4. John Rohner                             Difficulty: █▒▒▒▒▒▒▒▒▒
  5.  
  6. Milwaukee, Wisconsin                    Affected:  <nothing>
  7. Immortality (414-643-1576)                         *no programming necessary*
  8. rohner@csd.uwm.edu
  9.  
  10. Description:
  11.  
  12.    This provides a general description of the JMOD file format and
  13.    information about what these files are.
  14.  
  15. ───────────────────────────────────────────────────────────────────────────────
  16.  
  17. For each release, on Immortality I will maintain JMODxxyy.ZIP.  "xx" is the
  18. BBS release number, "yy" is the JMOD version number.  Example: JMOD0901.ZIP
  19.  
  20. Roughly each month (between releases) I will create a new JMOD.  It contains
  21. any bug fixes/enhancements I've been doing to the software since release.  
  22. As well as JDR_BBS related stuff others do.
  23.  
  24. At the time the next version of Juggernaut is released, any code modifications
  25. will be absorbed into the program itself--with a UNIX-like credit line for
  26. those submitted modifications at the top of the altered modules.
  27.  
  28. For those modifications/files that cannot be incorporated into the program,
  29. they will continue and be a part of the next JMOD series.
  30.  
  31. You should put each modification in a text file of similar format as this one.
  32.  
  33. For additional files, you should ZIP them into a .ZIP the same name as your
  34. modification text file.
  35.  
  36. For simple code alternations, you should mention the module name (eg. 
  37. USER_IO.BAS), the routine name (eg. GetDesc), and use the following format
  38. for the code changes:
  39.  
  40.     |  K = 100
  41.     |  K0 = 110
  42.     -  IF K <> K0 _
  43.     +  IF K > K0 _
  44.     |    THEN K$ = "TEST" _
  45.     |    ELSE K$ = "TEST2"
  46.  
  47. Thus, "|" means stays the same, "-" means remove it, "+" means insert it.
  48.  
  49. But to keep it from getting unreadable:
  50.  
  51.     |  K = 100
  52.     |  K0 = 110
  53.     -  IF K <> K0 _
  54.     -    THEN K$ = "TEST" _
  55.     -    ELSE K$ = "TEST2"
  56.     +  IF K > K0
  57.     +    THEN K$ = "TEST" _
  58.     +    ELSE K$ = "TEST3"
  59.     |  K1 = 200
  60.  
  61. Thus, one must strive for a happy (readable) balance when deciding on -/+'s.
  62.  
  63. Also, remember that there aren't just code change possibilities: you can do
  64. protocols, new contents listings output formats (headers and body), more
  65. "other BBS styles", your own styles, etc.
  66.  
  67. Also, pretty much anything you do for the first time can be a mod: telling how
  68. to convert a WWIV bundle to .PKT format for importing, routing your phone
  69. calls via your place-of-work's Unix system, setting up specific CD's, etc.
  70.  
  71. ═══════════════════════════════════════════════════════════════════════════════
  72.  
  73.